GET mailinglists/<domain>
Opis
Lista list pocztowych w obrębie wybranej domeny.
Sygnatura polecenia
- Metoda żądania - GET
- Ścieżka żądania (URL PATH) - wskazanie domeny pocztowej
- Parametry żądania (QUERY_STRING) - parametry wpływające na listę wyników poprzez paginację, sortowanie, wyszukiwanie
- Ciało żądania - puste
- Ciało odpowiedzi - lista znalezionych list pocztowych opisanych wybranymi parametrami oraz informacja o liczbie wszystkich pasujących zasobów do zadanych warunków zapytania
Parametry ścieżki:
(string)
domain
wymagany Nazwa domeny w obrębie której znajduje się lista pocztowa.
wymagany Nazwa domeny w obrębie której znajduje się lista pocztowa.
przykładowa wartość:
demo.kei.pl
(int)
page
Numer strony, liczony od zera.
(int)
size
Ilość pobieranych wierszy w jednym zapytaniu (domyślnie 50).
(string)
search
Fraza, po której filtrowane będą wyniki zapytania.
(string)
sort
Pole, po którym wyniki mają być sortowane.
(string)
sort_dir
Kierunek sortowania wyników - rosnąco czy malejąco.
dopuszczalne wartości:
- asc: rosnąco
- desc: malejąco
Struktura odpowiedzi
"result_info":{
"total": "- liczba wszystkich znalezionych wierszy"
"fetched": "- liczba zwroconych wierszy"
}
"result_data": {
"wynik_wyszukiwania":{
}
}"Przykładowe zapytanie:
GET https://as27.demo.kei.pl/v1/mailinglists/demo.kei.pl?page=0&sort=sortowane_pole&search=szukana_fraza&sort_dir=asc&size=50
Przykładowa odpowiedź:
{
"result_info":{
"total":2,
"fetched":2,
"page_size":50,
"page":0
},
"result_data":{
"lista":{
"email":"lista@demo.kei.pl",
"description":"",
"privacy_mode":"2",
"replyto_mode":"0",
"autosubscribe_enabled":"0",
"name":"lista",
"domain":"demo.kei.pl"
},
"drugalista":{
"email":"drugalista@demo.kei.pl",
"description":"biuro",
"privacy_mode":"0",
"replyto_mode":"0",
"autosubscribe_enabled":"0",
"name":"drugalista",
"domain":"demo.kei.pl"
}
}
}